Process/Definitions({FullName})/StartInstance

Simple method to start a new process instance for the specified process definition full name, without any data field values. To start a process instance with data field values, use Process/Instances/StartInstance

  Value Notes
URI {Service Root URI}/Process/Definitions({FullName})/StartInstance?{Query Options}
e.g.
https://api.denallix.com:443/K2Services/REST.svc/Process/Definitions(K2%20Examples_B_Order%20Process)/StartInstance?folio=Order-K2
  • FullName is a string and represents the full name of the process definition. Folder structures with slashes will require you to use Replacement Characters. to specify the path.
  • Custom Query Options
    • Folio (String) – the folio value to assign to the process instance.  Uses current DateTime as default if no value is provided.
Method GET  
Return Type

Process Instance Id (Long) or Failure

  
Return Example <long>3</long>
 

K2 blackpearl Developers Reference4.7
Video Links Learn Support
No videos found for this article
K2 on YouTube
No Additional links found for this article
No self-learning content for this article
Try some scenarios...
No relevant support links available for this article